<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SimpleDataMapper xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: SimpleDataMapper.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref/org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html $</em>
<a name="4" href="#4">4</a>   <em> * SimpleDataMapper.java - genericdao - Apr 25, 2008 4:29:45 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.springjdbc;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.File;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.HashMap;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.Map;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Map.Entry;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassLoaderUtils;
<a name="23" href="#23">23</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.DataMapper;
<a name="24" href="#24">24</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.NamesRecord;
<a name="25" href="#25">25</a>  <strong>import</strong> org.sakaiproject.genericdao.api.translators.DatabaseTranslator;
<a name="26" href="#26">26</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.BasicTranslator;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <em>/**<em>*</em></em>
<a name="30" href="#30">30</a>  <em> * This class allows us to generate a {@link DataMapper} using Spring or anything else that</em>
<a name="31" href="#31">31</a>  <em> * can set/inject strings to create an object, most of the functions are assumed to</em>
<a name="32" href="#32">32</a>  <em> * be handled automatically by generic DAO</em>
<a name="33" href="#33">33</a>  <em> * </em>
<a name="34" href="#34">34</a>  <em> * @author Aaron Zeckoski (azeckoski@gmail.com)</em>
<a name="35" href="#35">35</a>  <em> */</em>
<a name="36" href="#36">36</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a> implements <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> {
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>      <em>/**<em>*</em></em>
<a name="39" href="#39">39</a>  <em>     * Default constructor which is used by Spring mostly,</em>
<a name="40" href="#40">40</a>  <em>     * you will need to at least set the </em>
<a name="41" href="#41">41</a>  <em>     */</em>
<a name="42" href="#42">42</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a>() {}
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em>/**<em>*</em></em>
<a name="45" href="#45">45</a>  <em>     * This is primarily for use when using all gendao conventions and annotations with a class,</em>
<a name="46" href="#46">46</a>  <em>     * otherwise this will not include enough information to complete the mapping,</em>
<a name="47" href="#47">47</a>  <em>     * the tablename will be the classname if no annotation is used,</em>
<a name="48" href="#48">48</a>  <em>     * the id column must be ID if no annotation is used and the property must also be id</em>
<a name="49" href="#49">49</a>  <em>     * </em>
<a name="50" href="#50">50</a>  <em>     * @param persistentType any class type to map as a persistent type</em>
<a name="51" href="#51">51</a>  <em>     */</em>
<a name="52" href="#52">52</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a>(Class&lt;?> persistentType) {
<a name="53" href="#53">53</a>          <strong>this</strong>.persistentType = persistentType;
<a name="54" href="#54">54</a>      }
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <em>/**<em>*</em></em>
<a name="57" href="#57">57</a>  <em>     * This is useful when adhering to some of the gendao conventions</em>
<a name="58" href="#58">58</a>  <em>     * but needing to specify your own id property and tableName</em>
<a name="59" href="#59">59</a>  <em>     * </em>
<a name="60" href="#60">60</a>  <em>     * @param persistentType any class type to map as a persistent type</em>
<a name="61" href="#61">61</a>  <em>     * @param idPropertyName this is the property name matching the identifier for the table</em>
<a name="62" href="#62">62</a>  <em>     * @param tableName this is the name of the table that matches this persistent class</em>
<a name="63" href="#63">63</a>  <em>     */</em>
<a name="64" href="#64">64</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a>(Class&lt;?> persistentType, String idPropertyName, String tableName) {
<a name="65" href="#65">65</a>          <strong>this</strong>.idPropertyName = idPropertyName;
<a name="66" href="#66">66</a>          <strong>this</strong>.persistentType = persistentType;
<a name="67" href="#67">67</a>          <strong>this</strong>.tableName = tableName;
<a name="68" href="#68">68</a>      }
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <strong>private</strong> <strong>boolean</strong> usePropertyNamesForColumns = false;
<a name="71" href="#71">71</a>      <strong>public</strong> <strong>boolean</strong> isUsePropertyNamesForColumns() {
<a name="72" href="#72">72</a>          <strong>return</strong> usePropertyNamesForColumns;
<a name="73" href="#73">73</a>      }
<a name="74" href="#74">74</a>      <em>/**<em>*</em></em>
<a name="75" href="#75">75</a>  <em>     * (OPTIONAL)</em>
<a name="76" href="#76">76</a>  <em>     * This will cause the mapper to use the property names as is (case and characters)</em>
<a name="77" href="#77">77</a>  <em>     * for the columns names instead of transforming them (e.g. property: myThing => column: myThing),</em>
<a name="78" href="#78">78</a>  <em>     * default is false (that means property: myThing => column: MY_THING)</em>
<a name="79" href="#79">79</a>  <em>     */</em>
<a name="80" href="#80">80</a>      <strong>public</strong> <strong>void</strong> setUsePropertyNamesForColumns(<strong>boolean</strong> usePropertyNamesForColumns) {
<a name="81" href="#81">81</a>          <strong>this</strong>.usePropertyNamesForColumns = usePropertyNamesForColumns;
<a name="82" href="#82">82</a>      }
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>      <strong>protected</strong> String idPropertyName = <strong>null</strong>;
<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
<a name="86" href="#86">86</a>  <em>     * (OPTIONAL)</em>
<a name="87" href="#87">87</a>  <em>     * This is the name of the property on the persistent object which defines the unique identifier,</em>
<a name="88" href="#88">88</a>  <em>     * defaults to null if unset but that will be replaced by the proper id or the default of "id"</em>
<a name="89" href="#89">89</a>  <em>     */</em>
<a name="90" href="#90">90</a>      <strong>public</strong> <strong>void</strong> setIdPropertyName(String idPropertyName) {
<a name="91" href="#91">91</a>          <strong>this</strong>.idPropertyName = idPropertyName;
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>      <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="94" href="#94">94</a>  <em class="comment">     * @see org.sakaiproject.genericdao.api.DataMapper#getIdPropertyName()</em>
<a name="95" href="#95">95</a>  <em class="comment">     */</em>
<a name="96" href="#96">96</a>      <strong>public</strong> String getIdPropertyName() {
<a name="97" href="#97">97</a>          <strong>return</strong> idPropertyName;
<a name="98" href="#98">98</a>      }
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <strong>private</strong> Class&lt;?> persistentType;
<a name="101" href="#101">101</a>     <em>/**<em>*</em></em>
<a name="102" href="#102">102</a> <em>     * Allows setting the persistent type,</em>
<a name="103" href="#103">103</a> <em>     * this should normally be done in the constructor and cannot be changed</em>
<a name="104" href="#104">104</a> <em>     * once it has been set</em>
<a name="105" href="#105">105</a> <em>     * @param persistentType this is the class that maps to the DB table</em>
<a name="106" href="#106">106</a> <em>     * @throws IllegalArgumentException if the input is null or the value is already set</em>
<a name="107" href="#107">107</a> <em>     */</em>
<a name="108" href="#108">108</a>     <strong>public</strong> <strong>void</strong> setPersistentType(Class&lt;?> persistentType) {
<a name="109" href="#109">109</a>         <strong>if</strong> (persistentType == <strong>null</strong>) {
<a name="110" href="#110">110</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"The persistentType cannot be null"</span>);
<a name="111" href="#111">111</a>         }
<a name="112" href="#112">112</a>         <strong>if</strong> (<strong>this</strong>.persistentType != <strong>null</strong>) {
<a name="113" href="#113">113</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"The persistentType has already been set and cannot be reset"</span>);
<a name="114" href="#114">114</a>         }
<a name="115" href="#115">115</a>         <strong>this</strong>.persistentType = persistentType;
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a>     <em>/**<em>*</em></em>
<a name="118" href="#118">118</a> <em>     * (REQUIRED)</em>
<a name="119" href="#119">119</a> <em>     * set this to the class name (e.g. org.project.MyClass) </em>
<a name="120" href="#120">120</a> <em>     * and it will be converted into the class object</em>
<a name="121" href="#121">121</a> <em>     * @param persistentClassname this is the fully qualified classname of the persistent type</em>
<a name="122" href="#122">122</a> <em>     */</em>
<a name="123" href="#123">123</a>     <strong>public</strong> <strong>void</strong> setPersistentClassname(String persistentClassname) {
<a name="124" href="#124">124</a>         persistentType = ClassLoaderUtils.getClassFromString(persistentClassname);
<a name="125" href="#125">125</a>         <strong>if</strong> (persistentType == <strong>null</strong>) {
<a name="126" href="#126">126</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(
<a name="127" href="#127">127</a>                     <span class="string">"Invalid class name for persistentClassname, could not create class from string: "</span> + persistentClassname);
<a name="128" href="#128">128</a>         }
<a name="129" href="#129">129</a>     }
<a name="130" href="#130">130</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="131" href="#131">131</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.DataMapper#getPersistentType()</em>
<a name="132" href="#132">132</a> <em class="comment">     */</em>
<a name="133" href="#133">133</a>     <strong>public</strong> Class&lt;?> getPersistentType() {
<a name="134" href="#134">134</a>         <strong>return</strong> persistentType;
<a name="135" href="#135">135</a>     }
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>     <strong>protected</strong> String tableName;
<a name="138" href="#138">138</a>     <em>/**<em>*</em></em>
<a name="139" href="#139">139</a> <em>     * (OPTIONAL)</em>
<a name="140" href="#140">140</a> <em>     * set this to the name of the table,&lt;br/></em>
<a name="141" href="#141">141</a> <em>     * defaults to a name built from the simple class name of the persistent class</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     <strong>public</strong> <strong>void</strong> setTableName(String tableName) {
<a name="144" href="#144">144</a>         <strong>this</strong>.tableName = tableName;
<a name="145" href="#145">145</a>     }
<a name="146" href="#146">146</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="147" href="#147">147</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.DataMapper#getTableName()</em>
<a name="148" href="#148">148</a> <em class="comment">     */</em>
<a name="149" href="#149">149</a>     <strong>public</strong> String getTableName() {
<a name="150" href="#150">150</a>         <strong>if</strong> (tableName == <strong>null</strong>) {
<a name="151" href="#151">151</a>             <strong>if</strong> (persistentType != <strong>null</strong>) {
<a name="152" href="#152">152</a>                 tableName = BasicTranslator.makeTableNameFromClass(persistentType);
<a name="153" href="#153">153</a>             } <strong>else</strong> {
<a name="154" href="#154">154</a>                 <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"tablename and persistentType are both null, invalid DataMapper"</span>);
<a name="155" href="#155">155</a>             }
<a name="156" href="#156">156</a>         }
<a name="157" href="#157">157</a>         <strong>return</strong> tableName;
<a name="158" href="#158">158</a>     }
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> namesRecord = <strong>null</strong>;
<a name="161" href="#161">161</a>     <em>/**<em>*</em></em>
<a name="162" href="#162">162</a> <em>     * (OPTIONAL)</em>
<a name="163" href="#163">163</a> <em>     * Set this to a map of the persistent object properties to database column names,</em>
<a name="164" href="#164">164</a> <em>     * String -> String,&lt;br/></em>
<a name="165" href="#165">165</a> <em>     * example: "id" -> "ID", "title" -> "ITEM_TITLE"&lt;br/></em>
<a name="166" href="#166">166</a> <em>     * defaults to autogenerated column names which are uppercased and underscored (as in example above)</em>
<a name="167" href="#167">167</a> <em>     * @see SimpleDataMapper#setNamesUsed(String[])</em>
<a name="168" href="#168">168</a> <em>     * @see SimpleDataMapper#setNamesRecord(NamesRecord)</em>
<a name="169" href="#169">169</a> <em>     */</em>
<a name="170" href="#170">170</a>     <strong>public</strong> <strong>void</strong> setNamesMapping(Map&lt;String, String> namesMapping) {
<a name="171" href="#171">171</a>         <strong>if</strong> (namesMapping != <strong>null</strong> &amp;&amp; ! namesMapping.isEmpty()) {
<a name="172" href="#172">172</a>             namesRecord = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a>();
<a name="173" href="#173">173</a>             <strong>for</strong> (Entry&lt;String, String> entry : namesMapping.entrySet()) {
<a name="174" href="#174">174</a>                 String key = entry.getKey();
<a name="175" href="#175">175</a>                 String dbName = entry.getValue();
<a name="176" href="#176">176</a>                 <strong>if</strong> (dbName != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(dbName)) {
<a name="177" href="#177">177</a>                     namesRecord.setNameMapping(key, dbName);
<a name="178" href="#178">178</a>                 }
<a name="179" href="#179">179</a>             }
<a name="180" href="#180">180</a>         }
<a name="181" href="#181">181</a>     }
<a name="182" href="#182">182</a>     <em>/**<em>*</em></em>
<a name="183" href="#183">183</a> <em>     * (OPTIONAL)</em>
<a name="184" href="#184">184</a> <em>     * Set this to an array of the persistent object properties which will be used for this mapping,</em>
<a name="185" href="#185">185</a> <em>     * anything not listed will be ignored when forming queries,</em>
<a name="186" href="#186">186</a> <em>     * this is the least work but depends on the more conventions and allows the least control &lt;br/></em>
<a name="187" href="#187">187</a> <em>     * NOTE: Be sure to set {@link #setUsePropertyNamesForColumns(boolean)} before calling this method &lt;br/></em>
<a name="188" href="#188">188</a> <em>     * Example: ["id", "title"],&lt;br/></em>
<a name="189" href="#189">189</a> <em>     * "id" -> "ID", "title" -> "ITEM_TITLE"&lt;br/></em>
<a name="190" href="#190">190</a> <em>     * defaults to autogenerated column names which are uppercased and underscored (as in example above)</em>
<a name="191" href="#191">191</a> <em>     * depending on the setting for {@link #isUsePropertyNamesForColumns()}</em>
<a name="192" href="#192">192</a> <em>     * @see SimpleDataMapper#setNamesMapping(Map)</em>
<a name="193" href="#193">193</a> <em>     * @see SimpleDataMapper#setNamesRecord(NamesRecord)</em>
<a name="194" href="#194">194</a> <em>     */</em>
<a name="195" href="#195">195</a>     <strong>public</strong> <strong>void</strong> setNamesUsed(String[] namesUsed) {
<a name="196" href="#196">196</a>         <strong>if</strong> (namesUsed == <strong>null</strong>) {
<a name="197" href="#197">197</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"NamesRecord cannot be null"</span>);
<a name="198" href="#198">198</a>         }
<a name="199" href="#199">199</a>         namesRecord = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a>();
<a name="200" href="#200">200</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; namesUsed.length; i++) {
<a name="201" href="#201">201</a>             String propertyName = namesUsed[i];
<a name="202" href="#202">202</a>             String columnName = propertyName;
<a name="203" href="#203">203</a>             <strong>if</strong> (! isUsePropertyNamesForColumns()) {
<a name="204" href="#204">204</a>                 columnName = BasicTranslator.makeDBNameFromCamelCase(propertyName);
<a name="205" href="#205">205</a>             }
<a name="206" href="#206">206</a>             namesRecord.setNameMapping(propertyName, columnName);
<a name="207" href="#207">207</a>         }
<a name="208" href="#208">208</a>     }
<a name="209" href="#209">209</a>     <em>/**<em>*</em></em>
<a name="210" href="#210">210</a> <em>     * (OPTIONAL)</em>
<a name="211" href="#211">211</a> <em>     * Set the {@link NamesRecord} used for this mapping directly,</em>
<a name="212" href="#212">212</a> <em>     * this controls the mapping of object properties to database columns,</em>
<a name="213" href="#213">213</a> <em>     * this is more work than is probably needed but allows the most control, see the other methods</em>
<a name="214" href="#214">214</a> <em>     * @see SimpleDataMapper#setNamesMapping(Map)</em>
<a name="215" href="#215">215</a> <em>     * @see SimpleDataMapper#setNamesUsed(String[])</em>
<a name="216" href="#216">216</a> <em>     */</em>
<a name="217" href="#217">217</a>     <strong>public</strong> <strong>void</strong> setNamesRecord(<a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> namesRecord) {
<a name="218" href="#218">218</a>         <strong>if</strong> (namesRecord == <strong>null</strong>) {
<a name="219" href="#219">219</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"NamesRecord cannot be null"</span>);
<a name="220" href="#220">220</a>         }
<a name="221" href="#221">221</a>         <strong>this</strong>.namesRecord = namesRecord;
<a name="222" href="#222">222</a>     }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="225" href="#225">225</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.mappers.DataMapper#definePropertyToColumnMapping()</em>
<a name="226" href="#226">226</a> <em class="comment">     */</em>
<a name="227" href="#227">227</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> getPropertyToColumnNamesMapping() {
<a name="228" href="#228">228</a>         <strong>return</strong> namesRecord;
<a name="229" href="#229">229</a>     }
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>     <strong>private</strong> Map&lt;String, String> dbTypeToDDL = <strong>new</strong> HashMap&lt;String, String>();
<a name="232" href="#232">232</a>     <strong>public</strong> Map&lt;String, String> getDbTypeToDDL() {
<a name="233" href="#233">233</a>         <strong>return</strong> dbTypeToDDL;
<a name="234" href="#234">234</a>     }
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>     <em>/**<em>*</em></em>
<a name="237" href="#237">237</a> <em>     * Convenience method which allows setting the DDL for a database type,</em>
<a name="238" href="#238">238</a> <em>     * this will be appended to existing entries&lt;br/></em>
<a name="239" href="#239">239</a> <em>     * Generally only useful if you only need to set a single DDL&lt;br/></em>
<a name="240" href="#240">240</a> <em>     * </em>
<a name="241" href="#241">241</a> <em>     * @param databaseTypeConstant one of the database type constants from, e.g. {@link #DBTYPE_MYSQL},</em>
<a name="242" href="#242">242</a> <em>     * this indicates which database your DDL should work for</em>
<a name="243" href="#243">243</a> <em>     * @param ddl the ddl to execute to create the table(s) for this persistent object</em>
<a name="244" href="#244">244</a> <em>     */</em>
<a name="245" href="#245">245</a>     <strong>public</strong> <strong>void</strong> addDBTypeAndDDL(String databaseTypeConstant, String ddl) {
<a name="246" href="#246">246</a>         <strong>if</strong> (databaseTypeConstant == <strong>null</strong> || ddl == <strong>null</strong>) {
<a name="247" href="#247">247</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"databaseTypeConstant and ddl cannot be null"</span>);
<a name="248" href="#248">248</a>         }
<a name="249" href="#249">249</a>         <strong>if</strong> (dbTypeToDDL == <strong>null</strong>) {
<a name="250" href="#250">250</a>             dbTypeToDDL = <strong>new</strong> HashMap&lt;String, String>();
<a name="251" href="#251">251</a>         }
<a name="252" href="#252">252</a>         dbTypeToDDL.put(databaseTypeConstant, ddl);
<a name="253" href="#253">253</a>     }
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>     <strong>private</strong> Map&lt;String, String> dbTypeToFilename = <strong>new</strong> HashMap&lt;String, String>();
<a name="256" href="#256">256</a>     <strong>public</strong> Map&lt;String, String> getDbTypeToFilename() {
<a name="257" href="#257">257</a>         <strong>return</strong> dbTypeToFilename;
<a name="258" href="#258">258</a>     }
<a name="259" href="#259">259</a> 
<a name="260" href="#260">260</a>     <em>/**<em>*</em></em>
<a name="261" href="#261">261</a> <em>     * (REQUIRED/OPTIONAL)</em>
<a name="262" href="#262">262</a> <em>     * Sets the map of databaseTypeConstant -> file containing the DDL script,</em>
<a name="263" href="#263">263</a> <em>     * the DDL will be looked up and stored in the class and executed on service init&lt;br/></em>
<a name="264" href="#264">264</a> <em>     * This must be set if the table does not already exist but if it does then this is optional&lt;br/></em>
<a name="265" href="#265">265</a> <em>     * The first non-comment ('--') line will be run, and if successful, </em>
<a name="266" href="#266">266</a> <em>     * all other non-comment lines will be run. SQL statements may be on </em>
<a name="267" href="#267">267</a> <em>     * multiple lines but must have ';' terminators.&lt;br/></em>
<a name="268" href="#268">268</a> <em>     * Can use the {@link #makeDDLTypeMap(String, String[])} method to make this more easily &lt;br/></em>
<a name="269" href="#269">269</a> <em>     * The following keys will be replaced automatically:&lt;br/></em>
<a name="270" href="#270">270</a> <em>     * {TABLENAME} - the value returned by {@link #getTableName()}&lt;br/></em>
<a name="271" href="#271">271</a> <em>     * {ID} - the column name of the unique identifier&lt;br/></em>
<a name="272" href="#272">272</a> <em>     * {IDSEQNAME} - (Oracle) a sequence name will be generated and inserted</em>
<a name="273" href="#273">273</a> <em>     * based on the tablename for use in generating IDs,</em>
<a name="274" href="#274">274</a> <em>     * if you want to specify your own sequence name then you will lose</em>
<a name="275" href="#275">275</a> <em>     * the ability to have the ID inserted into newly created objects&lt;br/></em>
<a name="276" href="#276">276</a> <em>     * &lt;b>NOTE:&lt;/b> the file must be in your jar/war/package so it can</em>
<a name="277" href="#277">277</a> <em>     * be located in the classloader,</em>
<a name="278" href="#278">278</a> <em>     * use something like this in your maven pom.xml resources tag:</em>
<a name="279" href="#279">279</a> <em>     * &lt;xmp>&lt;resource></em>
<a name="280" href="#280">280</a> <em>        &lt;directory>${basedir}/src/sql&lt;/directory></em>
<a name="281" href="#281">281</a> <em>        &lt;includes></em>
<a name="282" href="#282">282</a> <em>          &lt;include>** /*.sql&lt;/include></em>
<a name="283" href="#283">283</a> <em>        &lt;/includes></em>
<a name="284" href="#284">284</a> <em>      &lt;/resource>&lt;/xmp></em>
<a name="285" href="#285">285</a> <em>     * Remove the space between ** and /* from the above sample&lt;br/></em>
<a name="286" href="#286">286</a> <em>     * For example: src/sql/mysql.sql, src/sql/mysql/myproject.ddl&lt;br/></em>
<a name="287" href="#287">287</a> <em>     * @see #setDBTypeToDDL(Map)</em>
<a name="288" href="#288">288</a> <em>     * @see #makeDDLTypeMap(String, String[])</em>
<a name="289" href="#289">289</a> <em>     */</em>
<a name="290" href="#290">290</a>     <strong>public</strong> <strong>void</strong> setDBTypeToFile(Map&lt;String, String> dbTypeToFile) {
<a name="291" href="#291">291</a>         <strong>if</strong> (dbTypeToFilename == <strong>null</strong>) {
<a name="292" href="#292">292</a>             dbTypeToFilename = <strong>new</strong> HashMap&lt;String, String>();
<a name="293" href="#293">293</a>         }
<a name="294" href="#294">294</a>         <strong>if</strong> (dbTypeToFile != <strong>null</strong>) {
<a name="295" href="#295">295</a>             <strong>for</strong> (Entry&lt;String, String> entry : dbTypeToFile.entrySet()) {
<a name="296" href="#296">296</a>                 String dbtype = entry.getKey().toUpperCase();
<a name="297" href="#297">297</a>                 String value = entry.getValue();
<a name="298" href="#298">298</a>                 <strong>if</strong> (value != <strong>null</strong>) {
<a name="299" href="#299">299</a>                     <strong>this</strong>.dbTypeToFilename.put(dbtype, value);
<a name="300" href="#300">300</a>                 }
<a name="301" href="#301">301</a>             }
<a name="302" href="#302">302</a>         }
<a name="303" href="#303">303</a>     }
<a name="304" href="#304">304</a> 
<a name="305" href="#305">305</a>     <em>/**<em>*</em></em>
<a name="306" href="#306">306</a> <em>     * (REQUIRED/OPTIONAL)</em>
<a name="307" href="#307">307</a> <em>     * Sets the map of databaseTypeConstant -> DDL,</em>
<a name="308" href="#308">308</a> <em>     * these will be appended to any existing values&lt;br/></em>
<a name="309" href="#309">309</a> <em>     * This must be set if the table does not already exist but if it does then this is optional&lt;br/></em>
<a name="310" href="#310">310</a> <em>     * The first non-comment ('--') line will be run, and if successful, </em>
<a name="311" href="#311">311</a> <em>     * all other non-comment lines will be run. SQL statements may be on </em>
<a name="312" href="#312">312</a> <em>     * multiple lines but must have ';' terminators.&lt;br/></em>
<a name="313" href="#313">313</a> <em>     * The following keys will be replaced automatically:&lt;br/></em>
<a name="314" href="#314">314</a> <em>     * {TABLENAME} - the value returned by {@link #getTableName()}&lt;br/></em>
<a name="315" href="#315">315</a> <em>     * {ID} - the column name of the unique identifier&lt;br/></em>
<a name="316" href="#316">316</a> <em>     * {IDSEQNAME} - (Oracle) a sequence name will be generated and inserted</em>
<a name="317" href="#317">317</a> <em>     * based on the tablename for use in generating IDs,</em>
<a name="318" href="#318">318</a> <em>     * if you want to specify your own sequence name then you will lose</em>
<a name="319" href="#319">319</a> <em>     * the ability to have the ID inserted into newly created objects&lt;br/></em>
<a name="320" href="#320">320</a> <em>     * @see #setDBTypeToFile(Map)</em>
<a name="321" href="#321">321</a> <em>     */</em>
<a name="322" href="#322">322</a>     <strong>public</strong> <strong>void</strong> setDBTypeToDDL(Map&lt;String, String> dbTypeToDDL) {
<a name="323" href="#323">323</a>         <strong>if</strong> (dbTypeToDDL == <strong>null</strong>) {
<a name="324" href="#324">324</a>             dbTypeToDDL = <strong>new</strong> HashMap&lt;String, String>();
<a name="325" href="#325">325</a>         }
<a name="326" href="#326">326</a>         <strong>if</strong> (dbTypeToDDL != <strong>null</strong>) {
<a name="327" href="#327">327</a>             <strong>for</strong> (Entry&lt;String, String> entry : dbTypeToDDL.entrySet()) {
<a name="328" href="#328">328</a>                 String dbtype = entry.getKey().toUpperCase();
<a name="329" href="#329">329</a>                 String value = entry.getValue();
<a name="330" href="#330">330</a>                 <strong>if</strong> (value != <strong>null</strong>) {
<a name="331" href="#331">331</a>                     <strong>this</strong>.dbTypeToDDL.put(dbtype, value);
<a name="332" href="#332">332</a>                 }
<a name="333" href="#333">333</a>             }
<a name="334" href="#334">334</a>         }
<a name="335" href="#335">335</a>     }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="338" href="#338">338</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.DataMapper#generateDDL(java.lang.String)</em>
<a name="339" href="#339">339</a> <em class="comment">     */</em>
<a name="340" href="#340">340</a>     <strong>public</strong> String generateDDL(String databaseTypeConstant) {
<a name="341" href="#341">341</a>         String ddl = <strong>null</strong>;
<a name="342" href="#342">342</a>         <strong>if</strong> (dbTypeToDDL != <strong>null</strong>) {
<a name="343" href="#343">343</a>             <strong>if</strong> (dbTypeToDDL.containsKey(databaseTypeConstant)) {
<a name="344" href="#344">344</a>                 ddl = dbTypeToDDL.get(databaseTypeConstant);
<a name="345" href="#345">345</a>             }
<a name="346" href="#346">346</a>         }
<a name="347" href="#347">347</a>         <strong>return</strong> ddl;
<a name="348" href="#348">348</a>         <em class="comment">//throw new UnsupportedOperationException("No support for the database type: " + databaseTypeConstant);</em>
<a name="349" href="#349">349</a>     }
<a name="350" href="#350">350</a> 
<a name="351" href="#351">351</a>     <em>/**<em>*</em></em>
<a name="352" href="#352">352</a> <em>     * This is a convenience method which assists in creating the ddl type map,</em>
<a name="353" href="#353">353</a> <em>     * it basically allows you to easily create the map if you have followed the convention</em>
<a name="354" href="#354">354</a> <em>     * of placing all your ddl files in folders which are equivalent to the name</em>
<a name="355" href="#355">355</a> <em>     * of the database type they are created for and named them all identically with</em>
<a name="356" href="#356">356</a> <em>     * a name which is similar to the </em>
<a name="357" href="#357">357</a> <em>     * @param fileName the name of the file (e.g. users.sql)</em>
<a name="358" href="#358">358</a> <em>     * @param types the types to include in the map, use the constants from {@link DatabaseTranslator} (e.g. "derby")</em>
<a name="359" href="#359">359</a> <em>     * @return the map which can be given to the {@link #setDBTypeToFile(Map)} method</em>
<a name="360" href="#360">360</a> <em>     */</em>
<a name="361" href="#361">361</a>     <strong>public</strong> <strong>static</strong> Map&lt;String, String> makeDDLTypeMap(String fileName, String[] types) {
<a name="362" href="#362">362</a>         <strong>if</strong> (fileName == <strong>null</strong> || <span class="string">""</span>.equals(fileName)) {
<a name="363" href="#363">363</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"fileName must not be null"</span>);
<a name="364" href="#364">364</a>         }
<a name="365" href="#365">365</a>         <strong>if</strong> (types == <strong>null</strong> || types.length == 0) {
<a name="366" href="#366">366</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Must include at least one type in the types array"</span>);
<a name="367" href="#367">367</a>         }
<a name="368" href="#368">368</a>         HashMap&lt;String, String> dbTypeToFile = <strong>new</strong> HashMap&lt;String, String>();
<a name="369" href="#369">369</a>         <strong>for</strong> (String type : types) {
<a name="370" href="#370">370</a>             dbTypeToFile.put(type, type.toLowerCase() + File.separator + fileName);
<a name="371" href="#371">371</a>         }
<a name="372" href="#372">372</a>         <strong>return</strong> dbTypeToFile;
<a name="373" href="#373">373</a>     }
<a name="374" href="#374">374</a> 
<a name="375" href="#375">375</a>     <em>/**<em>*</em></em>
<a name="376" href="#376">376</a> <em>     * Convenience method which will take a filename and an array of DBTYPE String constants</em>
<a name="377" href="#377">377</a> <em>     * (from {@link DatabaseTranslator}, example {@link DatabaseTranslator#DBTYPE_MYSQL})</em>
<a name="378" href="#378">378</a> <em>     * and produce a map of standard DDL types to file paths &lt;br/></em>
<a name="379" href="#379">379</a> <em>     * Will create a map like so: dbType -> [prefixPath/]dbType/fileName</em>
<a name="380" href="#380">380</a> <em>     * </em>
<a name="381" href="#381">381</a> <em>     * @param fileName the name of the sql file (e.g. myTableDDL.sql)</em>
<a name="382" href="#382">382</a> <em>     * @param dbTypes an array with 1 or more dbTypes which you have DDL files for</em>
<a name="383" href="#383">383</a> <em>     * @param prefixPath (optional) the prefix to append before the dbType and fileName (should not have a leading "/"),</em>
<a name="384" href="#384">384</a> <em>     * can be null or "" if npt used</em>
<a name="385" href="#385">385</a> <em>     * @return the map of dbType to file paths</em>
<a name="386" href="#386">386</a> <em>     * @throws IllegalArgumentException if the filename or dbTYpes are null or empty</em>
<a name="387" href="#387">387</a> <em>     */</em>
<a name="388" href="#388">388</a>     <strong>public</strong> <strong>static</strong> Map&lt;String, String> makeDDLMap(String fileName, String[] dbTypes, String prefixPath) {
<a name="389" href="#389">389</a>         <strong>if</strong> (fileName == <strong>null</strong> || <span class="string">""</span>.equals(fileName)) {
<a name="390" href="#390">390</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"filename must be set and cannot be null"</span>);
<a name="391" href="#391">391</a>         }
<a name="392" href="#392">392</a>         <strong>if</strong> (dbTypes == <strong>null</strong> || dbTypes.length == 0) {
<a name="393" href="#393">393</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"at least one dbType must be set and included, cannot be null or empty"</span>);
<a name="394" href="#394">394</a>         }
<a name="395" href="#395">395</a>         HashMap&lt;String, String> dbTypeToFile = <strong>new</strong> HashMap&lt;String, String>();
<a name="396" href="#396">396</a>         <strong>if</strong> (prefixPath == <strong>null</strong>) {
<a name="397" href="#397">397</a>             prefixPath = <span class="string">""</span>;
<a name="398" href="#398">398</a>         } <strong>else</strong> {
<a name="399" href="#399">399</a>             <strong>if</strong> (! prefixPath.endsWith(File.separator)) {
<a name="400" href="#400">400</a>                 prefixPath += File.separator;
<a name="401" href="#401">401</a>             }
<a name="402" href="#402">402</a>         }
<a name="403" href="#403">403</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; dbTypes.length; i++) {
<a name="404" href="#404">404</a>             String type = dbTypes[i];
<a name="405" href="#405">405</a>             dbTypeToFile.put(type, prefixPath + type.toLowerCase() + File.separator + fileName);
<a name="406" href="#406">406</a>         }
<a name="407" href="#407">407</a>         <strong>return</strong> dbTypeToFile;
<a name="408" href="#408">408</a>     }
<a name="409" href="#409">409</a> 
<a name="410" href="#410">410</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

